Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md #154

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

ryanoliverdev
Copy link

@ryanoliverdev ryanoliverdev commented Feb 11, 2023

Modified repositories README to add more information on how to make contributions, who the contributors are, and what the repository contains such as the various data structures and algorithms. I also added a usage section for how someone should format their contribution through the creation of a .h or .cpp file depending on if it's in the algorithm or data structure section.

@domfarolino
Copy link
Owner

Is #153 completely obsolete? What is the difference between that PR and this?

@ryanoliverdev
Copy link
Author

Is #153 completely obsolete? What is the difference between that PR and this?

I fixed some grammatical mistakes. #153 just had a missing sentence.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@ryanoliverdev
Copy link
Author

Made both the changes you requested


## License

[MIT](./LICENSE)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is actually no license file. This link is dead. We should probably remove this section and maybe in another PR add a license (and add this section back).


## Contributors

[<img src="https://contrib.rocks/image?repo=domfarolino/algorithms">](https://github.com/domfarolino/algorithms/graphs/contributors)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this is really cool!

algorithms specifically in C++. Judged problems along with other classic CS problems
are also contained within this repository.

## Contents
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As for contents, I think it might actually make sense to have a more concrete and deep structure. Right now these are just lists of folder names with no links really. Maybe we could have a table of contents in list form, kind of like this: https://github.com/domfarolino/mage#table-of-contents but where each indentation level is a new folder depth. So:

  • algorithm_practice
    • ACM_ICPC_Archive
    • Array_Algorithms
    • ....
  • datastructures
    • binary_search_tree
    • linked_list

This, and we can make each entry a relative link to the respective folder.

@domfarolino
Copy link
Owner

Hey @ryanoliverdev do you plan on continuing this PR or would you like me to take it over?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants